Fzzy Config/me.fzzyhmstrs.fzzy_config.util/ValidationResult/ErrorEntry

ErrorEntry

sealed interface ErrorEntry

Error context stored in a ValidationResult. This can represent an errored or non-errored state, can include multiple children contexts, and can include non-textual information (see ValidationResult.Errors.ACTION for example)

All Validation Results include an error entry; starting with a NonErrorEntry by default for a successful (non-errored) result.

Author

fzzyhmstrs

Since

0.7.0

Types

Builder

class Builder<C : Any>

Builds error entries. This is used in the UnaryOperator pattern seen in several places in this class, but can be used "freely" with builder

Companion

object Companion

Entry

sealed interface Entry<C : Any>

Represents the actual content stored within an error entry. This is used as a buffer between the error entry and code-facing interactions with it

Mutable

class Mutable(entry: ValidationResult.ErrorEntry)

A mutable wrapper of an error entry. This is typically used to provide an "entrypoint" for building errors based on a pre-defined header message. Use it with other validation results by calling ValidationResult.attachTo, and then build your final compound result with ValidationResult.ofMutable

Type

class Type<C : Any>(val name: String, val isString: Boolean = true, val isLoggable: Boolean = true, val isError: Boolean = true)

Type class representing a certain category of error content. This styles logged lines and can be used to store non-string content information.

Functions

addError

open fun addError(builder: UnaryOperator<ValidationResult.ErrorEntry.Builder<String>>): ValidationResult.ErrorEntry

Adds another error entry using ValidationResult.Errors.BASIC as the type, as a child to this one, using the builder to build that entry. Entries are immutable, so the updated entry is returned. The entry this is called on is not changed.

abstract fun addError(other: ValidationResult.ErrorEntry): ValidationResult.ErrorEntry

Adds another error entry as a child to this one. Entries are immutable, so the updated entry is returned. The entry this is called on is not changed.

abstract fun <C : Any> addError(type: ValidationResult.ErrorEntry.Type<C>, builder: UnaryOperator<ValidationResult.ErrorEntry.Builder<C>>): ValidationResult.ErrorEntry

Adds another error entry of the given type as a child to this one, using the builder to build that entry. Entries are immutable, so the updated entry is returned. The entry this is called on is not changed.

consumeAll

abstract fun consumeAll(c: Consumer<ValidationResult.ErrorEntry.Entry<*>>)

Performs the provided consumer action on this and any children entries.

consumeType

abstract fun <C : Any> consumeType(t: ValidationResult.ErrorEntry.Type<C>, c: Consumer<ValidationResult.ErrorEntry.Entry<C>>)

Performs the provided consumer action on this and any children entries if they are of the provided type.

getPlainString

abstract fun getPlainString(): String

Return the string representation of the logging for this entry without extra styling and type information.

getString

abstract fun getString(): String

Returns the string representation of the logging for this entry

hasType

abstract fun <C : Any> hasType(t: ValidationResult.ErrorEntry.Type<C>): Boolean

Whether this entry or one or more of its children is of the given type

isCritical

abstract fun isCritical(): Boolean

Whether this entry contains a critical error. It will have one or more exceptions attached to it

isEmpty

open fun isEmpty(): Boolean

Whether this entry is empty. An empty error is non-errored

isError

abstract fun isError(): Boolean

Whether the entry contains an errored state. This is usually true for textual error types, false for empty entries or entries containing non-text information.

isLoggable

abstract fun isLoggable(): Boolean

Whether this entry is loggable. Entries with a non-text type generally aren't.

iterateAll